home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / text / manipulation / qman101.lha / QMan.doc next >
Encoding:
Text File  |  1993-12-01  |  4.9 KB  |  131 lines
  1.             QMan V1.01 - another tool for help files
  2.            ------------------------------------------
  3.  
  4. Distribution:
  5. ~~~~~~~~~~~~
  6. QMan is FREEWARE. In short, you may copy it freely and use it as much
  7. as you want, providing that, if redistibuted, all files remain unchanged.
  8. The author claims copyright. The software is provided "As Is", which means
  9. that no warranties of any kind are given. The author can not be held responsible
  10. for any damages    the use of these files may cause. However, QMan    was extensively
  11. tested using the Enforcer/Mungwall/Sushi combination, and was found to be
  12. clean (no, you may NOT sue me if you get an enforcer-hit using QMan...)
  13.  
  14. Programming and testing was done on an A4000-040, 6Mb, 120Mb IDE + 105Mb
  15. Quantum LPS SCSI drives. Should run without problems on any Kickstart 2.x
  16. or 3.x system.
  17.  
  18. QMan was compiled with the excellent SAS/C V6.3 devlopement system.
  19.  
  20. QMan what?
  21. ~~~~~~~~~~
  22. QMan is a man-page launcher, like MAN (®1993 Kai Iske/Gunthersoft).
  23. Having used MAN for a while, I was getting tired of having to keep all
  24. my helpfiles in specific directories. Maybe there is other approach to this
  25. problem? The solution may be QMan.
  26.  
  27. QMan uses the quicktools.library (©1993 Eivind Nordseth/Ultima Thule Software)
  28. and the quicktools.files database. This is not an option, either use quicktools
  29. or don't use QMan. Anyway, if you don't have a copy of the brilliant Quicktools
  30. package, get it and install it! Now, all you have to do is call QMan with the
  31. following complex syntax:
  32.  
  33. QMan MANPAGE/A
  34.  
  35. QMan uses some environment variables to specify the textviewer to use. If
  36. QMan don't find the variables, it uses the default settings. These are:
  37.  
  38.  *Variable*         *For*             *Default setting*
  39. ------------    ----------------   -----------------------
  40. QMANVIEWER      Text files         Sys/Utilities/Multiview
  41. QMANVIEWERAG    AmigaGuide files   Sys/Utilities/Multiview
  42. QMANPATTERN     Filesuffixfilter   .(doc|guide|man)
  43. ------------    ----------------   -----------------------
  44.  
  45. The filesuffixfilter is appended to the searchstring MANPAGE, so keep in
  46. mind that a filter like #?(.doc|.guide) may display the mandelbrot.doc file
  47. in addition to the mandel.doc file you wanted to read. An additional
  48. feature of QMan is the abitity to display multiple files in one call. For
  49. example, QMan ar#? may display all docs starting with "ar".
  50.  
  51. For those of you not familiar with AmigaDOS, here's a quick tutorial:
  52. ---------------------------------------------------------------------
  53. Environment variables may be set the following way: setenv <variable> <statement>
  54.  
  55. If you use QMan a lot, you may want to include the defenitions in your
  56. user-startup file like this:
  57.  
  58.     .
  59.     .
  60.     setenv QMANPATTERN .(doc|guide|dok|gui|man|ascii|txt)   ; Just examples
  61.     setenv QMANVIEWER C:most                                ; Edit these as
  62.     setenv QMANVIEWERAG sys:utilities/multiview             ; you like.
  63.     .
  64.     .
  65.  
  66. Examples:
  67. ~~~~~~~~~
  68. You have set QMANVIEWER to c:muchmore and QMANPATTERN to .(doc|guide).
  69. QMANVIEWERAG is not specified.
  70.  
  71. Now, there are files on your harddisk named as follows:
  72.  
  73. Sys:text/AmigaGuide.guide
  74. Sys:Locale/Help/english/NComm.man
  75. Work:help/QMan.doc
  76. Work:help/ACalc.doc
  77. Work:CX/Toolmanager.guide
  78.  
  79. The following actions will produce the results:
  80. -----------------------------------------------
  81.     QMan NComm     -> No manpage found, because .man suffixes is not included 
  82.                    in the QMANPATTERN variable.
  83.     QMan Am#?    -> Starts muchmore with AmigaGuide.guide.
  84.     QMan A#?    -> muchmore <- AmigaGuide.guide, then muchmore <- ACalc.doc
  85.     QMan #?A#?    -> Displays all the manualpages one after the other.
  86.  
  87.  
  88. Bugs:
  89. ~~~~
  90. Files with double suffixes may be displayed, so that files which match
  91. patterns like #?.doc.index is concidered manpages and sent as argument to
  92. the viewer. This seldom causes any trouble, though.
  93.  
  94.  
  95. History:
  96. ~~~~~~~~
  97. V1.01    Fixed a mismatched FreeMem(). Gave away 3 bytes more than I got...
  98. V1.00    System crashed when trying something like QMan >NIL: <manpage>.
  99.         Rewrote a piece of the I/O-handling routine, and whoila!
  100. V0.99    Full of those creatures no one likes - BUGS!
  101.  
  102.  
  103. Future:
  104. ~~~~~~
  105. Will fix bugs if anyone finds them (I've tried to hide them well :-)
  106. Currently I'm working on a manviewer for WorkBench, a commodity with
  107. an extensive set of ARexx commands. There will be an option to use the
  108. quicktools file database in that one too.
  109.  
  110.  
  111. Author:
  112. ~~~~~~
  113. Torgeir Hovden, studying computer science at the Norwegian Institute of Technology
  114. (or was that in front of his Amiga?).
  115. Contact me if you like the program, have found bugs, have suggesions for future
  116. releases or just want to chat...
  117.  
  118. Torgeir Hovden
  119. Moholt Alle 20-62
  120. N-7035 TRONDHEIM
  121. NORWAY
  122.  
  123. OR
  124.  
  125. email: hovden@stud.unit.no
  126.  
  127. ------------------------------------------------------------------------------
  128. If builders built buildings the way programmers write programs, the first
  129. woodpecker would destroy civilization...
  130. ------------------------------------------------------------------------------
  131.